package org.jsola.contract.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.contract.dto.ContractVariableAddDTO;
import org.jsola.contract.dto.ContractVariableBatchDTO;
import org.jsola.contract.dto.ContractVariableUpdateDTO;
import org.jsola.contract.query.ContractVariableQuery;
import org.jsola.contract.vo.ContractVariableListVO;
import org.jsola.contract.vo.ContractVariableVO;
import org.jsola.core.Page;
import org.jsola.core.Result;

import java.util.List;

/**
 * 合同关联模板变量
 *
 * @author JanusMix
 */
@Api(tags = "contract-合同关联模板变量")
public interface IContractVariableControllerAPI {

    /**
     * 新增合同关联模板变量
     * @param contractVariableAddDTO 合同关联模板变量新增实体
     * @return 合同关联模板变量展示对象
     */
    @ApiOperation(value = "新增合同关联模板变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractVariableAddDTO", dataType = "ContractVariableAddDTO", value = "新增合同关联模板变量", paramType = "body")
    })
    Result<ContractVariableVO> save(ContractVariableAddDTO contractVariableAddDTO);


    /**
     * 修改合同关联模板变量
     * @param contractVariableUpdateDTO 合同关联模板变量
     * @return 更新数量
     */
    @ApiOperation(value = "修改合同关联模板变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractVariableUpdateDTO", dataType = "ContractVariableUpdateDTO", value = "修改合同关联模板变量", paramType = "body")
    })
    Result<Integer> update(ContractVariableUpdateDTO contractVariableUpdateDTO);

    /**
     * 批量编辑、新增、删除合同关联模板变量
     * @param contractVariableBatchDTO 要操作的合同关联模板变量
     * @return 操作之后的全部合同关联模板变量
     */
    @ApiOperation(value = "批量编辑、新增、删除合同关联模板变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractVariableBatchDTO", dataType = "ContractVariableBatchDTO", value = "要操作的字段数据", paramType = "body")
    })
    Result batch(ContractVariableBatchDTO contractVariableBatchDTO);



    /**
     * 删除单个合同关联模板变量，彻底删除
     * @param contractVariableId 合同关联模板变量id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个合同关联模板变量，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractVariableId", dataType = "Long", value = "合同关联模板变量id", paramType = "path")
    })
    Result<Integer> delete(Long contractVariableId);


    /**
     * 批量删除合同关联模板变量，彻底删除
     * @param contractVariableIds 合同关联模板变量id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除合同关联模板变量，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractVariableIds", dataType = "Long[]", value = "合同关联模板变量id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] contractVariableIds);


    /**
     * 根据合同关联模板变量id查询合同关联模板变量详情
     * @param contractVariableId 合同关联模板变量id
     * @return 合同关联模板变量详情
     */
    @ApiOperation(value="根据合同关联模板变量id查询合同关联模板变量详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractVariableId", dataType = "Long", value = "合同关联模板变量id", paramType = "path")
    })
    Result<ContractVariableVO> findById(Long contractVariableId);


    /**
     * 查询合同关联模板变量
     * @param contractVariableQuery 合同关联模板变量查询参数
     * @return page
     */
    @ApiOperation(value="查询合同关联模板变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractVariableQuery", dataType = "ContractVariableQuery", value = "合同关联模板变量查询参数", paramType = "query")
    })
    Result<List<ContractVariableListVO>> listAll(ContractVariableQuery contractVariableQuery);


     /**
     * 分页查询合同关联模板变量
     * @param contractVariableQuery 合同关联模板变量查询参数
     * @return page
     */
    @ApiOperation(value="分页查询合同关联模板变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractVariableQuery", dataType = "ContractVariableQuery", value = "合同关联模板变量查询参数", paramType = "query")
    })
    Result<Page<ContractVariableListVO>> page(ContractVariableQuery contractVariableQuery);


}

